home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / fish / 726-750 / 726 / p-reader / p-reader.doc < prev    next >
Text File  |  1995-03-18  |  14KB  |  305 lines
  1. PRE1
  2.                           P - R E A D E R V6.2 
  3.  
  4.                                                                               
  5.    Yet another infernal Reader.  There are hundreds of them already, reliable,
  6.    comprehensive, user-friendly, sitting around pleading to be used.  So pick 
  7.    the Readers that will properly display texts with multiple colour and style
  8.    changes, compressed texts, ILBMs.   Now the list gets shorter!   Find the  
  9.    Readers that will also display animations and sounds. . . Finally find the 
  10.    Readers that will show illustrated texts, with pictures and animations     
  11.    mixed in with the words.   What, none?                                     
  12.                                                                               
  13.    Wrong.  One.                                                               
  14.                                                                                
  15.    First the general instructions.  press HELP for a summary.                 
  16.                                                                               
  17.  
  18.                              INSTRUCTIONS 
  19.    Introduction
  21.       P-Reader can be used for:
  22.         All-purpose text reader.
  23.         Reader for special illustrated texts.
  24.         ILBM display, including HAM and cycling (where active).
  25.         Sounds (8SVX format).
  26.         ANIM5 type animation display.
  27.       
  28.       Texts, pictures and animations may be compressed (with P-Compress)
  29.   or uncompressed.  P-Reader will check and act accordingly.
  30.  
  31.       This reader forms the core of the complete P-Suite system.  Also included
  32.   in the Suite are:
  33.  
  34.    P-Writer.   A matching text editor with special facilities for writing in
  35.                 colour and style changes and calling up illustrations.
  36.    P-Compress. Compression and de-compression tool. (Includes P-Unpack).
  37.    P-Fixlib.   DOS patch utility.
  38.    P-Check.    Utility for checking suitability of IFF illustrations - ILBM
  39.                 and ANIM.
  40.    P-Animate.  Full-featured 3-D animation programme.
  41.    P-Index.    Active index/selector pages.
  42.  
  43.   Calling
  44.       From CLI:   P-Reader <FILE>
  45.          if no file is given P-Reader will open showing a file requester.
  46.  
  47.       From Workbench:  Click the icon. 
  48.          P-Reader will again open with a file requester.
  49.          To open with a file (may be a text, picture, sound, or animation),
  50.            hold <SHIFT> click the P-Reader icon, double-click the file icon.
  51.  
  52.     If you have Arp Library installed the standard Arp file requester will   
  53.   be used.
  55.   Operation
  56.  
  57.      P-Reader is mainly controlled by the ten function keys.  To produce a key 
  58.   strip index switch the printer on and click twice on the strip below with
  59.   the RIGHT mouse button to print it.  Cut out, join, print "P-Reader" on the 
  60.   back and enclose between two strips of clear Con-Tact film.
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67. #! 1 1 16 0 reader.key
  68.       A number of programs intercept the F keys and use them for other tasks.
  69.    If you find that your function keys do not give the expected response you
  70.    can use LSHIFT+1 in place of F1, LSHIFT+2 for F2, and so on - LSHIFT+0
  71.    replaces F10.
  72.    
  73.       It will be helpful to understand that P-Reader is essentially two readers
  74.    in one.  If an illustrated file is loaded - one calling IFF illustrations
  75.    in the text, and identified by the letters PRE at the start of the file - it
  76.    will open in ILLUSTRATED mode.  The header will show page number rather than
  77.    line number, scrolling and color selection are inhibited; if you then toggle
  78.    the NOP gadget you will change to the NORMAL mode - the header shows line
  79.    numbers, scrolling is enabled, the color gadget works but the NOP and NOC 
  80.    gadgets have no function.   If a normal text file has been loaded the reader
  81.    opens in NORMAL mode.
  82.  
  83.   Key functions
  84.  
  85.    F1: Move to Page [n].  To move to any page press <F1>, enter the number of 
  86.    the required page, press <RETURN>.
  87.  
  88.    F2, F3: Press <F2> or <F3> to get the first or last pages respectively.
  89.  
  90.    F4: Search.  Requester will appear.  Click on this and replace the word
  91.    "text" with the string  that you want to find.  Set case-sensitivity and
  92.    press <RETURN>.  The  search will always start at the beginning of the file.
  93.    A cursor will appear immediately before the required string.
  94.  
  95.    F5: Search again.  Search will continue from the last instance found.
  96.  
  97.     WARNING The Search window must remain active during the search process    
  98.    If your pointer automatically activates the window over which it is placed,
  99.      make sure that it remains over the Search window.                         
  100.  
  101.    F6: Print page.  The current page will be dumped to the printer.
  102.  
  103.    F7: Print file.  The whole file will be dumped.
  104.  
  105.    F8: Screen to back.  Since P-Reader opens its own screen & window, depth or
  106.    window shrinking gadgets are not useful.  <F8>, together with  <Amiga-N>
  107.    <Amiga-M> allow any screen to be brought up.
  108.  
  109.    F9: Load.  Brings up a file requester.  A new file can be selected at any
  110.    time.
  111.  
  112.    F10:  Save.  Brings up the file requester again.  The text will always be   
  113.    saved in normal un-compressed ASCii form.  ILBM illustrations in the text
  114.    will not be saved (but see below under "ILBM Display).  
  115.  
  116.    If you do not have the Arp library, a simple string gadget requester will
  117.    appear.  Enter the required file, press <return> and click <OK> or <CANCEL>.
  118.         
  119.    More functions are performed by page header gadgets. From left to right:
  120.  
  121.       Window close - terminates P-Reader.  
  122.       Page up      - just click on it (L mouse button).
  123.       NoP          - No Pictures. Toggles to suppress or enable graphics.
  124.                       Also enables scrolling and palette gadget.
  125.       Palette      - Click to cycle through available colors.  
  126.       NoC          - No Cycling.   Toggles to suppress or enable cycling.
  127.       Page Down    - Just click on it.
  128.     
  129.    The secondary functions of some keys of the numeric pad are activated:
  130.  
  131.       Home  (7)   - move to page 1.
  132.       End   (1)   - move to last page
  133.       Pg Up (9)   - move to previous page
  134.       Pg Dn (3)   - move to next page. 
  135.  
  136.  Window Size
  137.  
  138.     To make it possible to include illustrations an illustrated P-Reader text
  139.   has a set page size & color palette.  No scrolling or color changes while 
  140.   the NoP gadget is OFF. 
  141.  
  142.     As a simple text reader P-Reader opens a screen matching the current
  143.   display mode.  If however an illustrated file is loaded, a PAL (256 line) or 
  144.   NTSC (200 line) screen will be used according to detail in the file header.
  145.  
  146.  Scrolling
  147.     
  148.     Hold LMB down to scroll down; RMB scrolls up.  Press LSHIFT to toggle
  149.   scrolling speed.  In illustrated mode clicking the NoP gadget enables
  150.   scrolling but inhibits illustrations.
  151.  
  152.  ILBM Display
  153.  
  154.     To stop cycling (if active) click with the LEFT mouse button.
  155.     To dump to the printer place the pointer over the illustration and click
  156.   twice with the RIGHT mouse button.  Requester will ask for confirmation.
  157.  
  158.     P-Reader can be used as a stand-alone ILBM viewer.  In this role it will
  159.   accept any of the standard view-modes and screen depths.  
  160.  
  161.     To start cycling press <TAB>.
  162.     To stop cycling click once with the LEFT mouse button.    
  163.     To dump to the printer click twice with the RIGHT mouse button.
  164.     To close the screen click once with the LEFT mouse button.
  165.  
  166.  ANIMATION Display
  167.  
  168.     ANIM5s (as produced by DPaint, Videoscape, P-Animator, etc) can be shown
  169.   either as text illustrations or by themselves.  The animation will display
  170.   its opening screen while loading.  When the animation is called directly (ie
  171.   not from a text file) a switch can be used to set the framing rate in frames
  172.   /second; default is 7 frames/sec.  
  173.  
  174.     Starting from a cli just type the required rate (preceded by -r) after the
  175.   filename, eg
  176.                 P-Reader dh0:Marilyn -r12
  177.  
  178.     From Workbench enter RATE=12 in the Tool Types section of the icon used to
  179.   call the animation.
  180.  
  181.     To start the animation click the LEFT mouse button once.
  182.     To end the animation click again.
  183.     When used as an illustration the animation must be run (a double-click
  184.   suffices) before you can move on to the next page.
  185.  
  186.     Displaying large animations usually needs 1 Meg of memory.  Click on the
  187.   NoP gadget above if you have less.
  188.  
  189.  
  190.                            ILLUSTRATED TEXTS 
  191.  
  192.      The preparation of illustrated texts for P-Reader is much easier with 
  193.    P-Writer, its partner in the P-Suite stable.  However P-Writer is not
  194.    essential.
  195.  
  196.  Colour and Style Changes
  197.    The normal escape codes are used.    The most useful being:
  198.    reset   ^[[0;31;40m     b'ground Pen1  ^[[41m     style bold    ^[[1m
  199.    text Pen1   ^[[31m      b'ground Pen2  ^[[42m     style italic  ^[[3m 
  200.    text Pen2   ^[[32m      b'ground Pen3  ^[[43m     underline     ^[[4m
  201.    text Pen3   ^[[33m
  202.  
  203.    The initial ^[ represents the insert introducer or CSI, the non-printing
  204.    character produced by 'Esc'.  Refer to the instructions for your text
  205.    editor to see how to insert this.
  206.  
  207.  Three types of graphics (four if you count sounds) can be called :
  208.  
  209.  ILBMs (IFF pictures) 
  210.                        
  211.    True ILBMs produced by DPaint or any of the standard drawing software can
  212.    be used, provided that:
  213.  
  214.      Size is no greater than 640 X 256 (PAL) or 640 X 200 (NTSC).
  215.      No HAM or HALFBRITE.
  216.      Depth is three planes (eight colours).
  217.  
  218.    The picture shares a screen with the text, so the palette used by the
  219.    picture will affect screen colours.  Wherever possible the first four 
  220.    colours of the picture should be close to 000, FFA, 3F3, F20.  The rest of
  221.    the default palette is 45F, FC8, A60, 0A0.
  222.  
  223.       Calling syntax:  (do not leave any space between # and !) :
  224.  
  225.        # !  1 [Left edge] [Top edge] [Cycling] [File] 
  226.                                       (Cycling: ON = 1,  OFF = 0)
  227.  
  228.    The sequence may be placed anywhere on the page, but is best put at the
  229.    bottom so that all text is displayed first.  Any text after # followed by !
  230.    is not displayed. (Which is why "# followed by !" has to be written here.
  231.  
  232. ANIMATIONS                                     
  233.                                                     
  234.    This version supports straightforward ANIM5 animations as produced by
  235.  DPaint, Videoscape, The Projector, P_Animator and others.  Full information on
  236.  how to create animations for P-Reader will be given in P_Animator.    
  237.  
  238.    The command syntax is:  # ! 2 0 0 0 [File]           
  239.                                
  240.    The sequence can go anywhere on the page.  There should be no text directly 
  241.  under the anim.
  242.  
  243.   UP TO THREE ILBMs OR ONE ANIM MAY BE CALLED ON EACH PAGE
  244.  
  245.  SOUNDS
  246.  
  247.    Sound effects can be included if they are in the normal 8SVX format.        
  248.    Command syntax:  # ! 4 [File]
  249.  
  250.  BORDERS
  251.  
  252.    Provides a standard Intuition Border which may be used to enclose text or 
  253.   pictures.  
  255.    Command syntax is:  # ! 3 [Left edge] [Top line] [Width] [Height] [Pen]
  256.  
  257.    The command sequence may be placed anywhere on the page, however to prevent 
  258.   the border from being over-written by text it is best put on a line below
  259.   where the border will appear. 
  260.    
  261.  Identification
  262.  
  263.   To identify an illustrated text write the letters PRE at its very start,
  264.   followed immediately (no blank spaces) by 0 to indicate a PAL file or 1 for
  265.   an NTSC file.  
  266.  
  267.  
  268.   SUMMARY OF KEY-COMMANDS 
  269.  
  270.     F1 <page> or <line> <return>       Move to <page> or <line> 
  271.     F2/F3                              Move to first/final page
  272.     F4/F5                              Search/search again
  273.     F6/F7                              Print Page/File
  274.     F8                                 Move screen to back
  275.     F9                                 Get next file
  276.     F10                                Save file ASCII
  277.  
  278.     Inset graphics           Stop Cycling        Press any key
  279.                              Print               Click RMB twice
  280.   
  281.     ILBM reader              Start/stop cycling  Press <TAB>/any key
  282.                              Print               Click RMB twice
  283.  
  284.     Animation                Start               Click LBM
  285.                              Stop                Click again 
  286.  
  287.     Scroll up/down           RMB/LMB   <SHIFT> toggles speed
  288.  
  289.                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 
  290.  
  291.    P-Reader may be freely copied and circulated in whole or in part, provided 
  292.   that any distribution is accompanied by this file.   The programme may be
  293.   used for any non-commercial or non-profit-making purpose.  Authority for
  294.   commercial or profit-making purposes may be obtained from the author -
  295.   proposals for payment in kind will be looked on favorably. 
  296.  
  297.   Reactions, suggestions, bug-reports all welcome.
  298.  
  299.   A.M.H Wyndham
  300.   1265 Canning Mills Road,
  301.   Roleystone,
  302.   WA 6111
  303.   Australia
  304.  
  305.